ContentApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
AdminInvitesCodePost	Post /admin/invites/{code}	Create an Estuary invite
AdminInvitesGet	Get /admin/invites	Get Estuary invites
ContentAddCarPost	Post /content/add-car	Add Car object
ContentAddIpfsPost	Post /content/add-ipfs	Add IPFS object
ContentAddPost	Post /content/add	Add new content
ContentAggregatedContentGet	Get /content/aggregated/{content}	Get aggregated content stats
ContentAllDealsGet	Get /content/all-deals	Get all deals for a user
ContentBwUsageContentGet	Get /content/bw-usage/{content}	Get content bandwidth
ContentContentsGet	Get /content/contents	Get user contents
ContentCreatePost	Post /content/create	Add a new content
ContentDealsGet	Get /content/deals	Content with deals
ContentEnsureReplicationDatacidGet	Get /content/ensure-replication/{datacid}	Ensure Replication
ContentFailuresContentGet	Get /content/failures/{content}	List all failures for a content
ContentIdGet	Get /content/{id}	Content
ContentListGet	Get /content/list	List all pinned content
ContentStagingZonesGet	Get /content/staging-zones	Get staging zone for user, excluding its contents
ContentStagingZonesStagingZoneContentsGet	Get /content/staging-zones/{staging_zone}/contents	Get contents for a staging zone
ContentStagingZonesStagingZoneGet	Get /content/staging-zones/{staging_zone}	Get staging zone without its contents field populated
ContentStatsGet	Get /content/stats	Get content statistics
ContentStatusIdGet	Get /content/status/{id}	Content Status

AdminInvitesCodePost

string AdminInvitesCodePost(ctx, code) Create an Estuary invite

This endpoint is used to create an estuary invite.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
code	string	Invite code to be created

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminInvitesGet

string AdminInvitesGet(ctx, ) Get Estuary invites

This endpoint is used to list all estuary invites.

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentAddCarPost

UtilContentAddResponse ContentAddCarPost(ctx, body, optional) Add Car object

This endpoint is used to add a car object to the network. The object can be a file or a directory.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	string	Car
optional	*ContentApiContentAddCarPostOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ContentApiContentAddCarPostOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------

ignoreDupes | optional.| Ignore Dupes | filename | optional.| Filename |

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentAddIpfsPost

string ContentAddIpfsPost(ctx, body, optional) Add IPFS object

This endpoint is used to add an IPFS object to the network. The object can be a file or a directory.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	TypesIpfsPin	IPFS Body
optional	*ContentApiContentAddIpfsPostOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ContentApiContentAddIpfsPostOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------

ignoreDupes | optional.| Ignore Dupes | overwrite | optional.| Overwrite conflicting files in collections |

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentAddPost

UtilContentAddResponse ContentAddPost(ctx, data, filename, optional) Add new content

This endpoint is used to upload new content.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
data	*os.File***os.File**
filename	string
optional	*ContentApiContentAddPostOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ContentApiContentAddPostOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------

coluuid | optional.| Collection UUID | replication | optional.| Replication value | ignoreDupes | optional.| Ignore Dupes true/false | overwrite | optional.| Overwrite files with the same path on same collection | lazyProvide | optional.| Lazy Provide true/false | dir | optional.| Directory |

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentAggregatedContentGet

string ContentAggregatedContentGet(ctx, content) Get aggregated content stats

This endpoint returns aggregated content stats

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
content	string	Content ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentAllDealsGet

string ContentAllDealsGet(ctx, begin, duration, all) Get all deals for a user

This endpoint is used to get all deals for a user

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
begin	string	Begin
duration	string	Duration
all	string	All

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentBwUsageContentGet

string ContentBwUsageContentGet(ctx, content) Get content bandwidth

This endpoint returns content bandwidth

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
content	string	Content ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentContentsGet

string ContentContentsGet(ctx, limit, offset) Get user contents

This endpoint is used to get user contents

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
limit	string	limit
offset	string	offset

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentCreatePost

string ContentCreatePost(ctx, body, optional) Add a new content

This endpoint adds a new content

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	UtilContentCreateBody	Content
optional	*ContentApiContentCreatePostOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ContentApiContentCreatePostOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------

ignoreDupes | optional.| Ignore Dupes |

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentDealsGet

string ContentDealsGet(ctx, optional) Content with deals

This endpoint lists all content with deals

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ContentApiContentDealsGetOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ContentApiContentDealsGetOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- limit | optional.Int32| Limit | offset | optional.Int32| Offset |

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentEnsureReplicationDatacidGet

string ContentEnsureReplicationDatacidGet(ctx, datacid) Ensure Replication

This endpoint ensures that the content is replicated to the specified number of providers

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
datacid	string	Data CID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentFailuresContentGet

string ContentFailuresContentGet(ctx, content) List all failures for a content

This endpoint returns all failures for a content

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
content	string	Content ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentIdGet

string ContentIdGet(ctx, id) Content

This endpoint returns a content by its ID

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32	Content ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentListGet

string ContentListGet(ctx, ) List all pinned content

This endpoint lists all content

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentStagingZonesGet

string ContentStagingZonesGet(ctx, ) Get staging zone for user, excluding its contents

This endpoint is used to get staging zone for user, excluding its contents.

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentStagingZonesStagingZoneContentsGet

string ContentStagingZonesStagingZoneContentsGet(ctx, stagingZone, limit, offset) Get contents for a staging zone

This endpoint is used to get the contents for a staging zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stagingZone	int32	Staging Zone Content ID
limit	string	limit
offset	string	offset

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentStagingZonesStagingZoneGet

string ContentStagingZonesStagingZoneGet(ctx, stagingZone) Get staging zone without its contents field populated

This endpoint is used to get a staging zone, excluding its contents.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stagingZone	int32	Staging Zone Content ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentStatsGet

string ContentStatsGet(ctx, limit, offset) Get content statistics

This endpoint is used to get content statistics. Every content stored in the network (estuary) is tracked by a unique ID which can be used to get information about the content. This endpoint will allow the consumer to get the collected stats of a content

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
limit	string	limit
offset	string	offset

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentStatusIdGet

string ContentStatusIdGet(ctx, id) Content Status

This endpoint returns the status of a content

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32	Content ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]